<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>vprocss: Examples</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">vprocss
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li class="current"><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('example.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">Examples </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>You can refer to the below stated example applications for more details on how to use vprocss driver.</p>
<h1><a class="anchor" id="ex1"></a>
main.c</h1>
<p>Contains an example on how to use the XVprocss driver directly. This example is the main file for the Video Processing Subsystem.</p>
<p>For details, see main.c.</p>
<h1><a class="anchor" id="ex2"></a>
periph.c</h1>
<p>Contains an example on how to use the XVprocss driver directly. This example is the top level resource file that will initialize all system level peripherals.</p>
<p>For details, see <a class="el" href="periph_8c.html" title="This is top level resource file that will initialize all system level peripherals. ">periph.c</a>.</p>
<h1><a class="anchor" id="ex3"></a>
periph.h</h1>
<p>This is header for top level resource file that will initialize all system level peripherals.</p>
<p>For details, see <a class="el" href="periph_8h.html" title="This is header for resource file that will initialize all system level peripherals. ">periph.h</a>.</p>
<h1><a class="anchor" id="ex4"></a>
system.c</h1>
<p>Contains an example on how to use the XVprocss driver directly. This example is the top level resource file that will initialize all system level peripherals.</p>
<p>For details, see <a class="el" href="system_8c.html" title="This is top level resource file that will initialize all system level peripherals. ">system.c</a>.</p>
<h1><a class="anchor" id="ex5"></a>
system.h</h1>
<p>This is header for top level resource file that will initialize all system level peripherals.</p>
<p>For details, see <a class="el" href="system_8h.html" title="This is header for top level resource file that will initialize all system level peripherals. ">system.h</a>.</p>
<h1><a class="anchor" id="ex6"></a>
vpss_example.tcl</h1>
<p>Contains a tcl file which automates the process of generating the downloadable bit &amp; elf files from the provided example xsa file.</p>
<p>Example application design source files (contained within "examples/src" folder) are tightly coupled with the video processing subsystem example design available in Vivado Catalogue. To run this tcl</p>
<ol type="1">
<li>Copy the exported example design xsa file in the "examples" directory of the driver</li>
<li>Launch the xsct terminal</li>
<li>cd into the examples directory</li>
<li>source the tcl file <div class="fragment"><div class="line">xsct%&gt;source vpss_example.tcl </div>
</div><!-- fragment --></li>
<li>execute the script <div class="fragment"><div class="line">xsct%&gt;vpss_example &lt;xsa_file_name.xsa&gt; </div>
</div><!-- fragment --></li>
</ol>
<p>Script will perform following operations</p>
<ol type="1">
<li>Create workspace</li>
<li>Create HW project</li>
<li>Create BSP</li>
<li>Create Application Project</li>
<li>Build BSP and Application Project</li>
</ol>
<p>After the process is complete required files will be available in </p>
<pre class="fragment">  bit file -&gt; vpss_example.sdk/vpss_example_hw_platform folder
  elf file -&gt; vpss_example.sdk/vpss_example_design/{Debug/Release} folder
</pre><p>When executed on the board the example application will determine the video processing subsystem topology and set the input and output stream configuration accordingly. Test pattern generator IP is used to generate the input stream. Video Lock Monitor IP will then monitor the output of the subsystem (to vidout) to determine if lock is achieved and present the status (Pass/Fail) on the terminal.</p>
<dl class="section note"><dt>Note</dt><dd>Serial terminal baud rate should be set to 115200</dd></dl>
<p>For details, see vpss_example.tcl. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
